home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1994 November: Tool Chest / Dev.CD Nov 94.toast / Tool Chest / Development Tools & Languages / Macintosh Common Lisp Related / interfaces / QuickTime™ 1.5 interfaces / Components.lisp < prev    next >
Encoding:
Text File  |  1994-09-12  |  11.7 KB  |  296 lines  |  [TEXT/CCL2]
  1.  
  2. (in-package :TRAPS)             ;  
  3. ;  Created: Tuesday, October 13, 1992
  4. ;  Components.p
  5. ;  Pascal Interface to the Macintosh Libraries
  6. ; 
  7. ;  Copyright Apple Computer, Inc. 1991, 1992
  8. ;  All rights reserved
  9. ; 
  10.  
  11. ; $IFC UNDEFINED UsingIncludes
  12. ; $SETC UsingIncludes := 0
  13. ; $ENDC
  14.  
  15. ; $IFC NOT UsingIncludes
  16.  
  17. ; $ENDC
  18.  
  19. ; $IFC UNDEFINED UsingComponents
  20. ; $SETC UsingComponents := 1
  21.  
  22. ; $I+
  23. ; $SETC ComponentsIncludes := UsingIncludes
  24. ; $SETC UsingIncludes := 1
  25. ; $IFC UNDEFINED UsingTypes
  26.  
  27. (require-interface 'TYPES)      ; $I $$Shell(PInterfaces)Types.p
  28. ; $ENDC
  29. ; $IFC UNDEFINED UsingTypes
  30.  
  31. (require-interface 'MEMORY)     ; $I $$Shell(PInterfaces)Memory.p
  32. ; $ENDC
  33. ; $SETC UsingIncludes := ComponentsIncludes
  34.  
  35. (defconstant $gestaltComponentMgr :|cpnt|)
  36.  
  37. (defconstant $kAnyComponentType 0)
  38. (defconstant $kAnyComponentSubType 0)
  39. (defconstant $kAnyComponentManufacturer 0)
  40. (defconstant $kAnyComponentFlagsMask 0)
  41.  
  42. (defconstant $cmpWantsRegisterMessage #X80000000)
  43.  
  44. (defrecord ComponentDescription 
  45.    (componentType :OSTYPE)      ;  A unique 4-byte code indentifying the command set 
  46.    (componentSubType :OSTYPE)   ;  Particular flavor of this instance 
  47.    (componentManufacturer :OSTYPE);  Vendor indentification 
  48.    (componentFlags :SIGNED-LONG);  8 each for Component,Type,SubType,Manuf/revision 
  49.    (componentFlagsMask :SIGNED-LONG);  Mask for specifying which flags to consider in search, zero during registration 
  50.    )
  51.  
  52. (defrecord ResourceSpec 
  53.    (resType :OSTYPE)            ;  4-byte code  
  54.    (resId :SIGNED-INTEGER)      ;     
  55.    )
  56.  
  57. (def-mactype :COMPONENTRESOURCEPTR (find-mactype :POINTER))
  58. (def-mactype :COMPONENTRESOURCEHANDLE (find-mactype :HANDLE))
  59. (defrecord (ComponentResource :handle) 
  60.    (cd :COMPONENTDESCRIPTION)   ;  Registration parameters 
  61.    (component :RESOURCESPEC)    ;  resource where Component code is found 
  62.    (componentName :RESOURCESPEC);  name string resource 
  63.    (componentInfo :RESOURCESPEC);  info string resource 
  64.    (componentIcon :RESOURCESPEC);  icon resource 
  65.    )
  66.  
  67. (def-mactype :COMPONENT (find-mactype :POINTER))
  68. (def-mactype :COMPONENTINSTANCE (find-mactype :POINTER))
  69.  
  70. ;  Structure received by Component:  
  71. (defrecord ComponentParameters 
  72.    (flags :CHARACTER)           ;  call modifiers: sync/async, deferred, immed, etc 
  73.    (paramSize :CHARACTER)       ;  size in bytes of actual parameters passed to this call 
  74.    (what :SIGNED-INTEGER)       ;  routine selector, negative for Component management calls 
  75.    (params (:ARRAY :SIGNED-LONG 1));  actual parameters for the indicated routine 
  76.    )
  77.  
  78. (def-mactype :COMPONENTRESULT (find-mactype :SIGNED-LONG))
  79.  
  80. (def-mactype :COMPONENTROUTINE (find-mactype :POINTER))
  81.  
  82. (def-mactype :COMPONENTFUNCTION (find-mactype :POINTER))
  83.  
  84. ; ******************************************************
  85. ; * Required Component routines
  86. ; ******************************************************
  87.  
  88. (defconstant $kComponentOpenSelect -1);  ComponentInstance for this open 
  89. (defconstant $kComponentCloseSelect -2);  ComponentInstance for this close 
  90. (defconstant $kComponentCanDoSelect -3);  selector # being queried 
  91. (defconstant $kComponentVersionSelect -4);  no params 
  92. (defconstant $kComponentRegisterSelect -5);  no params 
  93. (defconstant $kComponentTargetSelect -6);  ComponentInstance for top of call chain 
  94.  
  95. ;  Set Default Component flags 
  96. (defconstant $defaultComponentIdentical 0)
  97. (defconstant $defaultComponentAnyFlags 1)
  98. (defconstant $defaultComponentAnyManufacturer 2)
  99. (defconstant $defaultComponentAnySubType 4)
  100. (defconstant $defaultComponentAnyFlagsAnyManufacturer (+ #$DEFAULTCOMPONENTANYFLAGS #$DEFAULTCOMPONENTANYMANUFACTURER))
  101. (defconstant $defaultComponentAnyFlagsAnyManufacturerAnySubType (+ #$DEFAULTCOMPONENTANYFLAGS (+ #$DEFAULTCOMPONENTANYMANUFACTURER #$DEFAULTCOMPONENTANYSUBTYPE)))
  102.  
  103. ;  errors from component manager & components 
  104. (defconstant $invalidComponentID -3000)
  105. (defconstant $validInstancesExist -3001)
  106. (defconstant $componentNotCaptured -3002)
  107. (defconstant $componentDontRegister -3003)
  108.  
  109. (defconstant $badComponentInstance #X80008001)
  110. (defconstant $badComponentSelector #X80008002)
  111.  
  112. ;  *******************************************************
  113. ; *                                                     *
  114. ; *              APPLICATION LEVEL CALLS                *
  115. ; *                                                     *
  116. ; *******************************************************
  117. ; * Component Database Add, Delete, and Query Routines 
  118. ; *******************************************************
  119. ;  
  120.  
  121. (deftrap _REGISTERCOMPONENT ((CD :COMPONENTDESCRIPTION) (COMPONENTENTRYPOINT :POINTER) (GLOBAL :SIGNED-INTEGER) (COMPONENTNAME :HANDLE) (COMPONENTINFO :HANDLE) (COMPONENTICON :HANDLE))
  122.    (:STACK (:POINTER :PRIVATECOMPONENTRECORD))
  123.    (:STACK-TRAP #xA82A :D0 1 CD COMPONENTENTRYPOINT GLOBAL COMPONENTNAME COMPONENTINFO COMPONENTICON))
  124.  
  125. (deftrap _REGISTERCOMPONENTRESOURCE ((TR (:HANDLE :COMPONENTRESOURCE)) (GLOBAL :SIGNED-INTEGER))
  126.    (:STACK (:POINTER :PRIVATECOMPONENTRECORD))
  127.    (:STACK-TRAP #xA82A :D0 18 TR GLOBAL))
  128.  
  129. (deftrap _UNREGISTERCOMPONENT ((ACOMPONENT (:POINTER :PRIVATECOMPONENTRECORD)))
  130.    (:STACK :SIGNED-INTEGER)
  131.    (:STACK-TRAP #xA82A :D0 2 ACOMPONENT))
  132.  
  133.  
  134. (deftrap _FINDNEXTCOMPONENT ((ACOMPONENT (:POINTER :PRIVATECOMPONENTRECORD)) (LOOKING :COMPONENTDESCRIPTION))
  135.    (:STACK (:POINTER :PRIVATECOMPONENTRECORD))
  136.    (:STACK-TRAP #xA82A :D0 4 ACOMPONENT LOOKING))
  137.  
  138. (deftrap _COUNTCOMPONENTS ((LOOKING :COMPONENTDESCRIPTION))
  139.    (:STACK :SIGNED-LONG)
  140.    (:STACK-TRAP #xA82A :D0 3 LOOKING))
  141.  
  142.  
  143. (deftrap _GETCOMPONENTINFO ((ACOMPONENT (:POINTER :PRIVATECOMPONENTRECORD)) (CD :COMPONENTDESCRIPTION) (COMPONENTNAME :HANDLE) (COMPONENTINFO :HANDLE) (COMPONENTICON :HANDLE))
  144.    (:STACK :SIGNED-INTEGER)
  145.    (:STACK-TRAP #xA82A :D0 5 ACOMPONENT CD COMPONENTNAME COMPONENTINFO COMPONENTICON))
  146.  
  147. (deftrap _GETCOMPONENTLISTMODSEED NIL
  148.    (:STACK :SIGNED-LONG)
  149.    (:STACK-TRAP #xA82A :D0 6))
  150.  
  151. ;  *******************************************************
  152. ; * Component Instance Allocation and dispatch routines 
  153. ; *******************************************************
  154. ;  
  155.  
  156. (deftrap _OPENCOMPONENT ((ACOMPONENT (:POINTER :PRIVATECOMPONENTRECORD)))
  157.    (:STACK (:POINTER :PRIVATECOMPONENTINSTANCERECORD))
  158.    (:STACK-TRAP #xA82A :D0 7 ACOMPONENT))
  159.  
  160. (deftrap _CLOSECOMPONENT ((ACOMPONENTINSTANCE (:POINTER :PRIVATECOMPONENTINSTANCERECORD)))
  161.    (:STACK :SIGNED-INTEGER)
  162.    (:STACK-TRAP #xA82A :D0 8 ACOMPONENTINSTANCE))
  163.  
  164.  
  165. (deftrap _GETCOMPONENTINSTANCEERROR ((ACOMPONENTINSTANCE (:POINTER :PRIVATECOMPONENTINSTANCERECORD)))
  166.    (:STACK :SIGNED-INTEGER)
  167.    (:STACK-TRAP #xA82A :D0 10 ACOMPONENTINSTANCE))
  168.  
  169. ;   direct calls to the Components  
  170.  
  171. (deftrap _COMPONENTFUNCTIONIMPLEMENTED ((CI (:POINTER :PRIVATECOMPONENTINSTANCERECORD)) (FTNNUMBER :SIGNED-INTEGER))
  172.    (:STACK :SIGNED-LONG)
  173.    (:STACK-TRAP #xA82A :D0 0 CI FTNNUMBER ((+ (ASH 2 16) 65533) :SIGNED-LONGINT)))
  174.  
  175. (deftrap _GETCOMPONENTVERSION ((CI (:POINTER :PRIVATECOMPONENTINSTANCERECORD)))
  176.    (:STACK :SIGNED-LONG)
  177.    (:STACK-TRAP #xA82A :D0 0 CI ((+ (ASH 0 16) 65532) :SIGNED-LONGINT)))
  178.  
  179. (deftrap _COMPONENTSETTARGET ((CI (:POINTER :PRIVATECOMPONENTINSTANCERECORD)) (TARGET (:POINTER :PRIVATECOMPONENTINSTANCERECORD)))
  180.    (:STACK :SIGNED-LONG)
  181.    (:STACK-TRAP #xA82A :D0 0 CI TARGET ((+ (ASH 4 16) 65530) :SIGNED-LONGINT)))
  182.  
  183. ; ****************************************************
  184. ; *                                                    *
  185. ; *               CALLS MADE BY Components             *
  186. ; *                                                    *
  187. ; ******************************************************
  188.  
  189. ;  *******************************************************
  190. ; * Component Management routines
  191. ; *******************************************************
  192. ;  
  193.  
  194. (deftrap _SETCOMPONENTINSTANCEERROR ((ACOMPONENTINSTANCE (:POINTER :PRIVATECOMPONENTINSTANCERECORD)) (THEERROR :SIGNED-INTEGER))
  195.    NIL
  196.    (:STACK-TRAP #xA82A :D0 11 ACOMPONENTINSTANCE THEERROR))
  197.  
  198.  
  199. (deftrap _GETCOMPONENTREFCON ((ACOMPONENT (:POINTER :PRIVATECOMPONENTRECORD)))
  200.    (:STACK :SIGNED-LONG)
  201.    (:STACK-TRAP #xA82A :D0 16 ACOMPONENT))
  202.  
  203. (deftrap _SETCOMPONENTREFCON ((ACOMPONENT (:POINTER :PRIVATECOMPONENTRECORD)) (THEREFCON :SIGNED-LONG))
  204.    NIL
  205.    (:STACK-TRAP #xA82A :D0 17 ACOMPONENT THEREFCON))
  206.  
  207.  
  208. (deftrap _OPENCOMPONENTRESFILE ((ACOMPONENT (:POINTER :PRIVATECOMPONENTRECORD)))
  209.    (:STACK :SIGNED-INTEGER)
  210.    (:STACK-TRAP #xA82A :D0 21 ACOMPONENT))
  211.  
  212. (deftrap _CLOSECOMPONENTRESFILE ((REFNUM :SIGNED-INTEGER))
  213.    (:STACK :SIGNED-INTEGER)
  214.    (:STACK-TRAP #xA82A :D0 24 REFNUM))
  215.  
  216. ;  *******************************************************
  217. ; * Component Instance Management routines
  218. ; *******************************************************
  219. ;  
  220.  
  221. (deftrap _GETCOMPONENTINSTANCESTORAGE ((ACOMPONENTINSTANCE (:POINTER :PRIVATECOMPONENTINSTANCERECORD)))
  222.    (:STACK :HANDLE)
  223.    (:STACK-TRAP #xA82A :D0 12 ACOMPONENTINSTANCE))
  224.  
  225. (deftrap _SETCOMPONENTINSTANCESTORAGE ((ACOMPONENTINSTANCE (:POINTER :PRIVATECOMPONENTINSTANCERECORD)) (THESTORAGE :HANDLE))
  226.    NIL
  227.    (:STACK-TRAP #xA82A :D0 13 ACOMPONENTINSTANCE THESTORAGE))
  228.  
  229.  
  230. (deftrap _GETCOMPONENTINSTANCEA5 ((ACOMPONENTINSTANCE (:POINTER :PRIVATECOMPONENTINSTANCERECORD)))
  231.    (:STACK :SIGNED-LONG)
  232.    (:STACK-TRAP #xA82A :D0 14 ACOMPONENTINSTANCE))
  233.  
  234. (deftrap _SETCOMPONENTINSTANCEA5 ((ACOMPONENTINSTANCE (:POINTER :PRIVATECOMPONENTINSTANCERECORD)) (THEA5 :SIGNED-LONG))
  235.    NIL
  236.    (:STACK-TRAP #xA82A :D0 15 ACOMPONENTINSTANCE THEA5))
  237.  
  238.  
  239. (deftrap _COUNTCOMPONENTINSTANCES ((ACOMPONENT (:POINTER :PRIVATECOMPONENTRECORD)))
  240.    (:STACK :SIGNED-LONG)
  241.    (:STACK-TRAP #xA82A :D0 19 ACOMPONENT))
  242.  
  243. ;   useful helper routines for convenient method dispatching  
  244.  
  245. (deftrap _CALLCOMPONENTFUNCTION ((PARAMS :COMPONENTPARAMETERS) (FUNC :POINTER))
  246.    (:STACK :SIGNED-LONG)
  247.    (:STACK-TRAP #xA82A :D0 255 PARAMS FUNC))
  248.  
  249. (deftrap _CALLCOMPONENTFUNCTIONWITHSTORAGE ((STORAGE :HANDLE) (PARAMS :COMPONENTPARAMETERS) (FUNC :POINTER))
  250.    (:STACK :SIGNED-LONG)
  251.    (:STACK-TRAP #xA82A :D0 255 STORAGE PARAMS FUNC))
  252.  
  253. (deftrap _DELEGATECOMPONENTCALL ((ORIGINALPARAMS :COMPONENTPARAMETERS) (CI (:POINTER :PRIVATECOMPONENTINSTANCERECORD)))
  254.    (:STACK :SIGNED-LONG)
  255.    (:STACK-TRAP #xA82A :D0 36 ORIGINALPARAMS CI))
  256.  
  257.  
  258. (deftrap _SETDEFAULTCOMPONENT ((ACOMPONENT (:POINTER :PRIVATECOMPONENTRECORD)) (FLAGS :SIGNED-INTEGER))
  259.    (:STACK :SIGNED-INTEGER)
  260.    (:STACK-TRAP #xA82A :D0 30 ACOMPONENT FLAGS))
  261.  
  262. (deftrap _OPENDEFAULTCOMPONENT ((COMPONENTTYPE :OSTYPE) (COMPONENTSUBTYPE :OSTYPE))
  263.    (:STACK (:POINTER :PRIVATECOMPONENTINSTANCERECORD))
  264.    (:STACK-TRAP #xA82A :D0 33 COMPONENTTYPE COMPONENTSUBTYPE))
  265.  
  266. (deftrap _CAPTURECOMPONENT ((CAPTUREDCOMPONENT (:POINTER :PRIVATECOMPONENTRECORD)) (CAPTURINGCOMPONENT (:POINTER :PRIVATECOMPONENTRECORD)))
  267.    (:STACK (:POINTER :PRIVATECOMPONENTRECORD))
  268.    (:STACK-TRAP #xA82A :D0 28 CAPTUREDCOMPONENT CAPTURINGCOMPONENT))
  269.  
  270. (deftrap _UNCAPTURECOMPONENT ((ACOMPONENT (:POINTER :PRIVATECOMPONENTRECORD)))
  271.    (:STACK :SIGNED-INTEGER)
  272.    (:STACK-TRAP #xA82A :D0 29 ACOMPONENT))
  273.  
  274. (deftrap _REGISTERCOMPONENTRESOURCEFILE ((RESREFNUM :SIGNED-INTEGER) (GLOBAL :SIGNED-INTEGER))
  275.    (:STACK :SIGNED-LONG)
  276.    (:STACK-TRAP #xA82A :D0 20 RESREFNUM GLOBAL))
  277.  
  278. ; $ENDC                         ;  UsingComponents 
  279.  
  280. ; $IFC NOT UsingIncludes
  281.  
  282. ; $ENDC
  283.  
  284.  
  285. (export '($BADCOMPONENTSELECTOR $BADCOMPONENTINSTANCE $COMPONENTDONTREGISTER
  286.           $COMPONENTNOTCAPTURED $VALIDINSTANCESEXIST $INVALIDCOMPONENTID
  287.           $DEFAULTCOMPONENTANYFLAGSANYMANUFACTURERANYSUBTYPE
  288.           $DEFAULTCOMPONENTANYFLAGSANYMANUFACTURER $DEFAULTCOMPONENTANYSUBTYPE
  289.           $DEFAULTCOMPONENTANYMANUFACTURER $DEFAULTCOMPONENTANYFLAGS
  290.           $DEFAULTCOMPONENTIDENTICAL $KCOMPONENTTARGETSELECT
  291.           $KCOMPONENTREGISTERSELECT $KCOMPONENTVERSIONSELECT
  292.           $KCOMPONENTCANDOSELECT $KCOMPONENTCLOSESELECT $KCOMPONENTOPENSELECT
  293.           $CMPWANTSREGISTERMESSAGE $KANYCOMPONENTFLAGSMASK
  294.           $KANYCOMPONENTMANUFACTURER $KANYCOMPONENTSUBTYPE $KANYCOMPONENTTYPE
  295.           $GESTALTCOMPONENTMGR))
  296. (provide-interface 'Components)